| /******************************************************************************* |
| * Copyright (c) 2000, 2016 IBM Corporation and others. |
| * All rights reserved. This program and the accompanying materials |
| * are made available under the terms of the Eclipse Public License v1.0 |
| * which accompanies this distribution, and is available at |
| * http://www.eclipse.org/legal/epl-v10.html |
| * |
| * Contributors: |
| * IBM Corporation - initial API and implementation |
| * Terry Parker <tparker@google.com> (Google Inc.) https://bugs.eclipse.org/365499 |
| * Stephan Herrmann - Contribution for |
| * Bug 440477 - [null] Infrastructure for feeding external annotations into compilation |
| *******************************************************************************/ |
| package org.eclipse.jdt.internal.core; |
| import java.util.HashMap; |
| import java.util.Map; |
| |
| import org.eclipse.jdt.core.IJavaElement; |
| import org.eclipse.jdt.core.IJavaProject; |
| import org.eclipse.jdt.core.IPackageFragment; |
| import org.eclipse.jdt.core.IPackageFragmentRoot; |
| import org.eclipse.jdt.core.ITypeRoot; |
| import org.eclipse.jdt.internal.core.util.LRUCache; |
| import org.eclipse.jdt.internal.core.util.Util; |
| |
| /** |
| * The cache of java elements to their respective info. |
| */ |
| public class JavaModelCache { |
| public static boolean VERBOSE = false; |
| public static boolean DEBUG_CACHE_INSERTIONS = false; |
| |
| public static final int DEFAULT_PROJECT_SIZE = 5; // average 25552 bytes per project. |
| public static final int DEFAULT_ROOT_SIZE = 50; // average 2590 bytes per root -> maximum size : 25900*BASE_VALUE bytes |
| public static final int DEFAULT_PKG_SIZE = 500; // average 1782 bytes per pkg -> maximum size : 178200*BASE_VALUE bytes |
| public static final int DEFAULT_OPENABLE_SIZE = 250; // average 6629 bytes per openable (includes children) -> maximum size : 662900*BASE_VALUE bytes |
| public static final int DEFAULT_CHILDREN_SIZE = 250*20; // average 20 children per openable |
| public static final String RATIO_PROPERTY = "org.eclipse.jdt.core.javamodelcache.ratio"; //$NON-NLS-1$ |
| public static final String JAR_TYPE_RATIO_PROPERTY = "org.eclipse.jdt.core.javamodelcache.jartyperatio"; //$NON-NLS-1$ |
| |
| public static final Object NON_EXISTING_JAR_TYPE_INFO = new Object(); |
| |
| /* |
| * The memory ratio that should be applied to the above constants. |
| */ |
| protected double memoryRatio = -1; |
| |
| /** |
| * Active Java Model Info |
| */ |
| protected JavaElementInfo modelInfo; |
| |
| /** |
| * Cache of open projects. |
| */ |
| protected HashMap<IJavaProject, JavaElementInfo> projectCache; |
| |
| /** |
| * Cache of open package fragment roots. |
| */ |
| protected ElementCache<IPackageFragmentRoot> rootCache; |
| |
| /** |
| * Cache of open package fragments |
| */ |
| protected ElementCache<IPackageFragment> pkgCache; |
| |
| /** |
| * Cache of open compilation unit and class files |
| */ |
| protected ElementCache<ITypeRoot> openableCache; |
| |
| /** |
| * Cache of open children of openable Java Model Java elements |
| */ |
| protected Map<IJavaElement, Object> childrenCache; |
| |
| /** |
| * Cache of open binary type (inside a jar) that have a non-open parent |
| * Values are either instance of IBinaryType or Object (see {@link #NON_EXISTING_JAR_TYPE_INFO}) |
| */ |
| protected LRUCache<IJavaElement, Object> jarTypeCache; |
| |
| public JavaModelCache() { |
| // set the size of the caches as a function of the maximum amount of memory available |
| double ratio = getMemoryRatio(); |
| // adjust the size of the openable cache using the RATIO_PROPERTY property |
| double openableRatio = getOpenableRatio(); |
| this.projectCache = new HashMap<>(DEFAULT_PROJECT_SIZE); // NB: Don't use a LRUCache for projects as they are constantly reopened (e.g. during delta processing) |
| if (VERBOSE) { |
| this.rootCache = new VerboseElementCache<>((int) (DEFAULT_ROOT_SIZE * ratio), "Root cache"); //$NON-NLS-1$ |
| this.pkgCache = new VerboseElementCache<>((int) (DEFAULT_PKG_SIZE * ratio), "Package cache"); //$NON-NLS-1$ |
| this.openableCache = new VerboseElementCache<>((int) (DEFAULT_OPENABLE_SIZE * ratio * openableRatio), "Openable cache"); //$NON-NLS-1$ |
| } else { |
| this.rootCache = new ElementCache<>((int) (DEFAULT_ROOT_SIZE * ratio)); |
| this.pkgCache = new ElementCache<>((int) (DEFAULT_PKG_SIZE * ratio)); |
| this.openableCache = new ElementCache<>((int) (DEFAULT_OPENABLE_SIZE * ratio * openableRatio)); |
| } |
| this.childrenCache = new HashMap<>((int) (DEFAULT_CHILDREN_SIZE * ratio * openableRatio)); |
| resetJarTypeCache(); |
| } |
| |
| private double getOpenableRatio() { |
| return getRatioForProperty(RATIO_PROPERTY); |
| } |
| |
| private double getJarTypeRatio() { |
| return getRatioForProperty(JAR_TYPE_RATIO_PROPERTY); |
| } |
| |
| private double getRatioForProperty(String propertyName) { |
| String property = System.getProperty(propertyName); |
| if (property != null) { |
| try { |
| return Double.parseDouble(property); |
| } catch (NumberFormatException e) { |
| // ignore |
| Util.log(e, "Could not parse value for " + propertyName + ": " + property); //$NON-NLS-1$ //$NON-NLS-2$ |
| } |
| } |
| return 1.0; |
| } |
| |
| /** |
| * Returns the info for the element. |
| */ |
| public Object getInfo(IJavaElement element) { |
| switch (element.getElementType()) { |
| case IJavaElement.JAVA_MODEL: |
| return this.modelInfo; |
| case IJavaElement.JAVA_PROJECT: |
| return this.projectCache.get(element); |
| case IJavaElement.PACKAGE_FRAGMENT_ROOT: |
| return this.rootCache.get((IPackageFragmentRoot) element); |
| case IJavaElement.PACKAGE_FRAGMENT: |
| return this.pkgCache.get((IPackageFragment) element); |
| case IJavaElement.COMPILATION_UNIT: |
| case IJavaElement.CLASS_FILE: |
| return this.openableCache.get((ITypeRoot) element); |
| case IJavaElement.TYPE: |
| Object result = this.jarTypeCache.get(element); |
| if (result != null) |
| return result; |
| else |
| return this.childrenCache.get(element); |
| default: |
| return this.childrenCache.get(element); |
| } |
| } |
| |
| /* |
| * Returns the existing element that is equal to the given element if present in the cache. |
| * Returns the given element otherwise. |
| */ |
| public IJavaElement getExistingElement(IJavaElement element) { |
| switch (element.getElementType()) { |
| case IJavaElement.JAVA_MODEL: |
| return element; |
| case IJavaElement.JAVA_PROJECT: |
| return element; // projectCache is a Hashtable and Hashtables don't support getKey(...) |
| case IJavaElement.PACKAGE_FRAGMENT_ROOT: |
| return this.rootCache.getKey((IPackageFragmentRoot) element); |
| case IJavaElement.PACKAGE_FRAGMENT: |
| return this.pkgCache.getKey((IPackageFragment) element); |
| case IJavaElement.COMPILATION_UNIT: |
| case IJavaElement.CLASS_FILE: |
| return this.openableCache.getKey((ITypeRoot) element); |
| case IJavaElement.TYPE: |
| return element; // jarTypeCache or childrenCache are Hashtables and Hashtables don't support getKey(...) |
| default: |
| return element; // childrenCache is a Hashtable and Hashtables don't support getKey(...) |
| } |
| } |
| |
| protected double getMemoryRatio() { |
| if ((int) this.memoryRatio == -1) { |
| long maxMemory = Runtime.getRuntime().maxMemory(); |
| // if max memory is infinite, set the ratio to 4d which corresponds to the 256MB that Eclipse defaults to |
| // (see https://bugs.eclipse.org/bugs/show_bug.cgi?id=111299) |
| this.memoryRatio = maxMemory == Long.MAX_VALUE ? 4d : ((double) maxMemory) / (64 * 0x100000); // 64MB is the base memory for most JVM |
| } |
| return this.memoryRatio; |
| } |
| |
| /** |
| * Returns the info for this element without |
| * disturbing the cache ordering. |
| */ |
| protected Object peekAtInfo(IJavaElement element) { |
| switch (element.getElementType()) { |
| case IJavaElement.JAVA_MODEL: |
| return this.modelInfo; |
| case IJavaElement.JAVA_PROJECT: |
| return this.projectCache.get(element); |
| case IJavaElement.PACKAGE_FRAGMENT_ROOT: |
| return this.rootCache.peek((IPackageFragmentRoot) element); |
| case IJavaElement.PACKAGE_FRAGMENT: |
| return this.pkgCache.peek((IPackageFragment) element); |
| case IJavaElement.COMPILATION_UNIT: |
| case IJavaElement.CLASS_FILE: |
| return this.openableCache.peek((ITypeRoot) element); |
| case IJavaElement.TYPE: |
| Object result = this.jarTypeCache.peek(element); |
| if (result != null) |
| return result; |
| else |
| return this.childrenCache.get(element); |
| default: |
| return this.childrenCache.get(element); |
| } |
| } |
| |
| /** |
| * Remember the info for the element. |
| */ |
| protected void putInfo(IJavaElement element, Object info) { |
| if (DEBUG_CACHE_INSERTIONS) { |
| System.out.println(Thread.currentThread() + " cache putInfo (" + getElementType(element) + " " + element.toString() + ", " + info + ")"); //$NON-NLS-1$//$NON-NLS-2$//$NON-NLS-3$//$NON-NLS-4$ |
| } |
| switch (element.getElementType()) { |
| case IJavaElement.JAVA_MODEL: |
| this.modelInfo = (JavaElementInfo) info; |
| break; |
| case IJavaElement.JAVA_PROJECT: |
| this.projectCache.put((IJavaProject) element, (JavaElementInfo) info); |
| this.rootCache.ensureSpaceLimit((JavaElementInfo) info, element); |
| break; |
| case IJavaElement.PACKAGE_FRAGMENT_ROOT: |
| this.rootCache.put((IPackageFragmentRoot) element, (JavaElementInfo) info); |
| this.pkgCache.ensureSpaceLimit((JavaElementInfo) info, element); |
| break; |
| case IJavaElement.PACKAGE_FRAGMENT: |
| this.pkgCache.put((IPackageFragment) element, (JavaElementInfo) info); |
| this.openableCache.ensureSpaceLimit((JavaElementInfo) info, element); |
| break; |
| case IJavaElement.COMPILATION_UNIT: |
| case IJavaElement.CLASS_FILE: |
| this.openableCache.put((ITypeRoot) element, (JavaElementInfo) info); |
| break; |
| default: |
| this.childrenCache.put(element, info); |
| } |
| } |
| |
| public static String getElementType(IJavaElement element) { |
| String elementType; |
| switch (element.getElementType()) { |
| case IJavaElement.JAVA_PROJECT: |
| elementType = "project"; //$NON-NLS-1$ |
| break; |
| case IJavaElement.PACKAGE_FRAGMENT_ROOT: |
| elementType = "root"; //$NON-NLS-1$ |
| break; |
| case IJavaElement.PACKAGE_FRAGMENT: |
| elementType = "package"; //$NON-NLS-1$ |
| break; |
| case IJavaElement.CLASS_FILE: |
| elementType = "class file"; //$NON-NLS-1$ |
| break; |
| case IJavaElement.COMPILATION_UNIT: |
| elementType = "compilation unit"; //$NON-NLS-1$ |
| break; |
| default: |
| elementType = "element"; //$NON-NLS-1$ |
| } |
| return elementType; |
| } |
| |
| /** |
| * Removes the info of the element from the cache. |
| */ |
| protected void removeInfo(JavaElement element) { |
| if (DEBUG_CACHE_INSERTIONS) { |
| String elementToString = element.toString(); |
| System.out.println(Thread.currentThread() + " cache removeInfo " + getElementType(element) + " " + elementToString); //$NON-NLS-1$//$NON-NLS-2$ |
| } |
| switch (element.getElementType()) { |
| case IJavaElement.JAVA_MODEL: |
| this.modelInfo = null; |
| break; |
| case IJavaElement.JAVA_PROJECT: |
| this.projectCache.remove((IJavaProject)element); |
| this.rootCache.resetSpaceLimit((int) (DEFAULT_ROOT_SIZE * getMemoryRatio()), element); |
| break; |
| case IJavaElement.PACKAGE_FRAGMENT_ROOT: |
| this.rootCache.remove((IPackageFragmentRoot) element); |
| this.pkgCache.resetSpaceLimit((int) (DEFAULT_PKG_SIZE * getMemoryRatio()), element); |
| break; |
| case IJavaElement.PACKAGE_FRAGMENT: |
| this.pkgCache.remove((IPackageFragment) element); |
| this.openableCache.resetSpaceLimit((int) (DEFAULT_OPENABLE_SIZE * getMemoryRatio() * getOpenableRatio()), element); |
| break; |
| case IJavaElement.COMPILATION_UNIT: |
| case IJavaElement.CLASS_FILE: |
| this.openableCache.remove((ITypeRoot) element); |
| break; |
| default: |
| this.childrenCache.remove(element); |
| } |
| } |
| protected void resetJarTypeCache() { |
| this.jarTypeCache = new LRUCache<>((int) (DEFAULT_OPENABLE_SIZE * getMemoryRatio() * getJarTypeRatio())); |
| } |
| protected void removeFromJarTypeCache(BinaryType type) { |
| this.jarTypeCache.flush(type); |
| } |
| @Override |
| public String toString() { |
| return toStringFillingRation(""); //$NON-NLS-1$ |
| } |
| public String toStringFillingRation(String prefix) { |
| StringBuffer buffer = new StringBuffer(); |
| buffer.append(prefix); |
| buffer.append("Project cache: "); //$NON-NLS-1$ |
| buffer.append(this.projectCache.size()); |
| buffer.append(" projects\n"); //$NON-NLS-1$ |
| buffer.append(prefix); |
| buffer.append(this.rootCache.toStringFillingRation("Root cache")); //$NON-NLS-1$ |
| buffer.append('\n'); |
| buffer.append(prefix); |
| buffer.append(this.pkgCache.toStringFillingRation("Package cache")); //$NON-NLS-1$ |
| buffer.append('\n'); |
| buffer.append(prefix); |
| buffer.append(this.openableCache.toStringFillingRation("Openable cache")); //$NON-NLS-1$ |
| buffer.append('\n'); |
| buffer.append(prefix); |
| buffer.append(this.jarTypeCache.toStringFillingRation("Jar type cache")); //$NON-NLS-1$ |
| buffer.append('\n'); |
| return buffer.toString(); |
| } |
| } |