Author: markt Date: Mon Oct 17 14:56:30 2011 New Revision: 1185231 URL: http://svn.apache.org/viewvc?rev=1185231&view=rev Log: Improve start up time by caching the result of parsing the global and host level web.xml files.
Modified: tomcat/tc7.0.x/trunk/ (props changed) tomcat/tc7.0.x/trunk/java/org/apache/catalina/startup/ContextConfig.java tomcat/tc7.0.x/trunk/java/org/apache/catalina/startup/LocalStrings.properties tomcat/tc7.0.x/trunk/webapps/docs/changelog.xml Propchange: tomcat/tc7.0.x/trunk/ ------------------------------------------------------------------------------ --- svn:mergeinfo (original) +++ svn:mergeinfo Mon Oct 17 14:56:30 2011 @@ -1 +1 @@ -/tomcat/trunk:1156115,1156171,1156276,1156304,1156519,1156530,1156602,1157015,1157018,1157151,1157198,1157204,1157810,1157832,1157834,1157847,1157908,1157939,1158155,1158160,1158176,1158195,1158198-1158199,1158227,1158331,1158334-1158335,1158426,1160347,1160592,1160611,1160619,1160626,1160639,1160652,1160720-1160721,1160772,1160774,1160776,1161303,1161310,1161322,1161339,1161486,1161540,1161549,1161584,1162082,1162149,1162169,1162721,1162769,1162836,1162932,1163630,1164419,1164438,1164469,1164480,1164567,1165234,1165247-1165248,1165253,1165273,1165282,1165309,1165331,1165338,1165347,1165360-1165361,1165367-1165368,1165602,1165608,1165677,1165693,1165721,1165723,1165728,1165730,1165738,1165746,1165765,1165777,1165918,1165921,1166077,1166150-1166151,1166290,1166366,1166620,1166686,1166752,1166757,1167368,1167394,1169447,1170647,1171692,1172233-1172234,1172236,1172269,1172278,1172282,1172610,1172664,1172689,1172711,1173020-1173021,1173082,1173088,1173090,1173096,1173241,1173256 ,1173288,1173333,1173342,1173461,1173614,1173630,1173659,1173722,1174061,1174239,1174322,1174325,1174329-1174330,1174337-1174339,1174343,1174353,1174799,1174882,1174884,1174983,1175155,1175158,1175167,1175182,1175190,1175201,1175272,1175275,1175283,1175582,1175589-1175590,1175594,1175602,1175613,1175633,1175690,1175713,1175889,1175896,1175907,1176584,1176590,1176799,1177050,1177060,1177125,1177152,1177160,1177245,1177850,1177862,1177978,1178209,1178228,1178233,1178449,1178542,1178681,1178721,1180261,1180907,1181028,1181123,1181125,1181136,1181291,1181743,1182796,1183078,1183105,1183328,1183492-1183494,1183605,1184917,1184919,1185018,1185020,1185200 +/tomcat/trunk:1156115,1156171,1156276,1156304,1156519,1156530,1156602,1157015,1157018,1157151,1157198,1157204,1157810,1157832,1157834,1157847,1157908,1157939,1158155,1158160,1158176,1158195,1158198-1158199,1158227,1158331,1158334-1158335,1158426,1160347,1160592,1160611,1160619,1160626,1160639,1160652,1160720-1160721,1160772,1160774,1160776,1161303,1161310,1161322,1161339,1161486,1161540,1161549,1161584,1162082,1162149,1162169,1162721,1162769,1162836,1162932,1163630,1164419,1164438,1164469,1164480,1164567,1165234,1165247-1165248,1165253,1165273,1165282,1165309,1165331,1165338,1165347,1165360-1165361,1165367-1165368,1165602,1165608,1165677,1165693,1165721,1165723,1165728,1165730,1165738,1165746,1165765,1165777,1165918,1165921,1166077,1166150-1166151,1166290,1166366,1166620,1166686,1166752,1166757,1167368,1167394,1169447,1170647,1171692,1172233-1172234,1172236,1172269,1172278,1172282,1172610,1172664,1172689,1172711,1173020-1173021,1173082,1173088,1173090,1173096,1173241,1173256 ,1173288,1173333,1173342,1173461,1173614,1173630,1173659,1173722,1174061,1174239,1174322,1174325,1174329-1174330,1174337-1174339,1174343,1174353,1174799,1174882,1174884,1174983,1175155,1175158,1175167,1175182,1175190,1175201,1175272,1175275,1175283,1175582,1175589-1175590,1175594,1175602,1175613,1175633,1175690,1175713,1175889,1175896,1175907,1176584,1176590,1176799,1177050,1177060,1177125,1177152,1177160,1177245,1177850,1177862,1177978,1178209,1178228,1178233,1178449,1178542,1178681,1178721,1180261,1180907,1181028,1181123,1181125,1181136,1181291,1181743,1182796,1183078,1183105,1183142,1183328,1183339-1183340,1183492-1183494,1183605,1184917,1184919,1185018,1185020,1185200 Modified: tomcat/tc7.0.x/trunk/java/org/apache/catalina/startup/ContextConfig.java URL: http://svn.apache.org/viewvc/tomcat/tc7.0.x/trunk/java/org/apache/catalina/startup/ContextConfig.java?rev=1185231&r1=1185230&r2=1185231&view=diff ============================================================================== --- tomcat/tc7.0.x/trunk/java/org/apache/catalina/startup/ContextConfig.java (original) +++ tomcat/tc7.0.x/trunk/java/org/apache/catalina/startup/ContextConfig.java Mon Oct 17 14:56:30 2011 @@ -29,6 +29,7 @@ import java.io.InputStreamReader; import java.io.UnsupportedEncodingException; import java.net.JarURLConnection; import java.net.MalformedURLException; +import java.net.URI; import java.net.URISyntaxException; import java.net.URL; import java.net.URLConnection; @@ -43,6 +44,7 @@ import java.util.Locale; import java.util.Map; import java.util.Properties; import java.util.Set; +import java.util.concurrent.ConcurrentHashMap; import javax.servlet.ServletContainerInitializer; import javax.servlet.ServletContext; @@ -172,6 +174,13 @@ public class ContextConfig protected static long deploymentCount = 0L; + /** + * Cache of default web.xml fragments per Host + */ + protected static final Map<Host,DefaultWebXmlCacheEntry> hostWebXmlCache = + new ConcurrentHashMap<Host,DefaultWebXmlCacheEntry>(); + + // ----------------------------------------------------- Instance Variables /** * Custom mappings of login methods to authenticators @@ -1225,7 +1234,6 @@ public class ContextConfig * web.xml file. */ protected void webConfig() { - WebXml webXml = createWebXml(); /* Anything and everything can override the global and host defaults. * This is implemented in two parts * - Handle as a web fragment that gets added after everything else so @@ -1233,34 +1241,11 @@ public class ContextConfig * - Mark Servlets as overridable so SCI configuration can replace * configuration from the defaults */ - WebXml webXmlDefaultFragment = createWebXml(); - webXmlDefaultFragment.setOverridable(true); - // Set to distributable else every app will be prevented from being - // distributable when the default fragment is merged with the main - // web.xml - webXmlDefaultFragment.setDistributable(true); - // When merging, the default welcome files are only used if the app has - // not defined any welcomes files. - webXmlDefaultFragment.setAlwaysAddWelcomeFiles(false); + Set<WebXml> defaults = new HashSet<WebXml>(); + defaults.add(getDefaultWebXmlFragment()); - // Parse global web.xml if present - InputSource globalWebXml = getGlobalWebXmlSource(); - if (globalWebXml == null) { - // This is unusual enough to log - log.info(sm.getString("contextConfig.defaultMissing")); - } else { - parseWebXml(globalWebXml, webXmlDefaultFragment, false); - } + WebXml webXml = createWebXml(); - // Parse host level web.xml if present - // Additive apart from welcome pages - webXmlDefaultFragment.setReplaceWelcomeFiles(true); - InputSource hostWebXml = getHostWebXmlSource(); - parseWebXml(hostWebXml, webXmlDefaultFragment, false); - - Set<WebXml> defaults = new HashSet<WebXml>(); - defaults.add(webXmlDefaultFragment); - // Parse context level web.xml InputSource contextWebXml = getContextWebXmlSource(); parseWebXml(contextWebXml, webXml, false); @@ -1391,6 +1376,87 @@ public class ContextConfig } } + private WebXml getDefaultWebXmlFragment() { + + // Host should never be null + Host host = (Host) context.getParent(); + + DefaultWebXmlCacheEntry entry = hostWebXmlCache.get(host); + + InputSource globalWebXml = getGlobalWebXmlSource(); + InputSource hostWebXml = getHostWebXmlSource(); + + long globalTimeStamp = 0; + long hostTimeStamp = 0; + + if (globalWebXml != null) { + try { + File f = new File(new URI(globalWebXml.getSystemId())); + globalTimeStamp = f.lastModified(); + } catch (URISyntaxException e) { + globalTimeStamp = -1; + } + } + + if (hostWebXml != null) { + try { + File f = new File(new URI(hostWebXml.getSystemId())); + hostTimeStamp = f.lastModified(); + } catch (URISyntaxException e) { + hostTimeStamp = -1; + } + } + + if (entry != null && entry.getGlobalTimeStamp() == globalTimeStamp && + entry.getHostTimeStamp() == hostTimeStamp) { + return entry.getWebXml(); + } + + // Parsing global web.xml is relatively expensive. Use a sync block to + // make sure it only happens once + synchronized (host) { + entry = hostWebXmlCache.get(host); + if (entry != null && entry.getGlobalTimeStamp() == globalTimeStamp && + entry.getHostTimeStamp() == hostTimeStamp) { + return entry.getWebXml(); + } + + WebXml webXmlDefaultFragment = createWebXml(); + webXmlDefaultFragment.setOverridable(true); + // Set to distributable else every app will be prevented from being + // distributable when the default fragment is merged with the main + // web.xml + webXmlDefaultFragment.setDistributable(true); + // When merging, the default welcome files are only used if the app has + // not defined any welcomes files. + webXmlDefaultFragment.setAlwaysAddWelcomeFiles(false); + + // Parse global web.xml if present + if (globalWebXml == null) { + // This is unusual enough to log + log.info(sm.getString("contextConfig.defaultMissing")); + } else { + parseWebXml(globalWebXml, webXmlDefaultFragment, false); + } + + // Parse host level web.xml if present + // Additive apart from welcome pages + webXmlDefaultFragment.setReplaceWelcomeFiles(true); + + parseWebXml(hostWebXml, webXmlDefaultFragment, false); + + // Don't update the cache if an error occurs + if (globalTimeStamp != -1 && hostTimeStamp != -1) { + entry = new DefaultWebXmlCacheEntry(webXmlDefaultFragment, + globalTimeStamp, hostTimeStamp); + hostWebXmlCache.put(host, entry); + } + + return webXmlDefaultFragment; + } + } + + private void convertJsps(WebXml webXml) { Map<String,String> jspInitParams; ServletDef jspServlet = webXml.getServlets().get("jsp"); @@ -1607,6 +1673,7 @@ public class ContextConfig return getWebXmlSource(defaultWebXml, getBaseDir()); } + /** * Identify the host web.xml to be used and obtain an input source for * it. @@ -1623,7 +1690,7 @@ public class ContextConfig try { basePath = configBase.getCanonicalPath(); } catch (IOException e) { - log.error(sm.getString("contectConfig.baseError"), e); + log.error(sm.getString("contextConfig.baseError"), e); return null; } @@ -1703,10 +1770,10 @@ public class ContextConfig if(stream != null) { source = new InputSource(getClass().getClassLoader().getResource( - filename).toString()); + filename).toURI().toString()); } } else { - source = new InputSource("file://" + file.getAbsolutePath()); + source = new InputSource(file.getAbsoluteFile().toURI().toString()); stream = new FileInputStream(file); context.addWatchedResource(file.getAbsolutePath()); } @@ -2434,4 +2501,29 @@ public class ContextConfig return fragments; } } + + private static class DefaultWebXmlCacheEntry { + private final WebXml webXml; + private final long globalTimeStamp; + private final long hostTimeStamp; + + public DefaultWebXmlCacheEntry(WebXml webXml, long globalTimeStamp, + long hostTimeStamp) { + this.webXml = webXml; + this.globalTimeStamp = globalTimeStamp; + this.hostTimeStamp = hostTimeStamp; + } + + public WebXml getWebXml() { + return webXml; + } + + public long getGlobalTimeStamp() { + return globalTimeStamp; + } + + public long getHostTimeStamp() { + return hostTimeStamp; + } + } } Modified: tomcat/tc7.0.x/trunk/java/org/apache/catalina/startup/LocalStrings.properties URL: http://svn.apache.org/viewvc/tomcat/tc7.0.x/trunk/java/org/apache/catalina/startup/LocalStrings.properties?rev=1185231&r1=1185230&r2=1185231&view=diff ============================================================================== --- tomcat/tc7.0.x/trunk/java/org/apache/catalina/startup/LocalStrings.properties (original) +++ tomcat/tc7.0.x/trunk/java/org/apache/catalina/startup/LocalStrings.properties Mon Oct 17 14:56:30 2011 @@ -27,7 +27,7 @@ contextConfig.authenticatorInstantiate=C contextConfig.authenticatorMissing=Cannot configure an authenticator for method {0} contextConfig.authenticatorResources=Cannot load authenticators mapping list contextConfig.badUrl=Unable to process context descriptor [{0}] -contectConfig.baseError=Unable to determine $CATALINA_BASE +contextConfig.baseError=Unable to determine location of global configuration (usually $CATALINA_BASE/conf) contextConfig.cce=Lifecycle event data object {0} is not a Context contextConfig.contextClose=Error closing context.xml contextConfig.contextMissing=Missing context.xml: {0} Modified: tomcat/tc7.0.x/trunk/webapps/docs/changelog.xml URL: http://svn.apache.org/viewvc/tomcat/tc7.0.x/trunk/webapps/docs/changelog.xml?rev=1185231&r1=1185230&r2=1185231&view=diff ============================================================================== --- tomcat/tc7.0.x/trunk/webapps/docs/changelog.xml (original) +++ tomcat/tc7.0.x/trunk/webapps/docs/changelog.xml Mon Oct 17 14:56:30 2011 @@ -91,6 +91,10 @@ In <code>OneLineFormatter</code> log formatter in JULI always use the US locale to format the date (esp. the month names). (rjung) </fix> + <add> + Cache the results of parsing the global and host level web.xml files to + improve web application start time. (markt) + </add> </changelog> </subsection> <subsection name="Coyote"> --------------------------------------------------------------------- To unsubscribe, e-mail: dev-unsubscr...@tomcat.apache.org For additional commands, e-mail: dev-h...@tomcat.apache.org