/**
* Licensed to the Apache Software Foundation (ASF) under one
* or more contributor license agreements. See the NOTICE file
* distributed with this work for additional information
* regarding copyright ownership. The ASF licenses this file
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
* KIND, either express or implied. See the License for the
* specific language governing permissions and limitations
* under the License.
*/
package org.codehaus.groovy.reflection;
import groovy.lang.*;
import org.codehaus.groovy.reflection.GroovyClassValue.ComputeValue;
import org.codehaus.groovy.reflection.stdclasses.*;
import org.codehaus.groovy.util.*;
import org.codehaus.groovy.vmplugin.VMPluginFactory;
import java.lang.ref.PhantomReference;
import java.lang.ref.SoftReference;
import java.lang.ref.WeakReference;
import java.math.BigDecimal;
import java.math.BigInteger;
import java.util.*;
import java.util.concurrent.atomic.AtomicInteger;
/**
* Handle for all information we want to keep about the class
*
* @author Alex.Tkachman
*/
public class ClassInfo {
private final LazyCachedClassRef cachedClassRef;
private final LazyClassLoaderRef artifactClassLoader;
private final LockableObject lock = new LockableObject();
public final int hash = -1;
private final Class klazz;
private final AtomicInteger version = new AtomicInteger();
private MetaClass strongMetaClass;
private ManagedReference<MetaClass> weakMetaClass;
MetaMethod[] dgmMetaMethods = CachedClass.EMPTY;
MetaMethod[] newMetaMethods = CachedClass.EMPTY;
private ManagedConcurrentMap<Object, MetaClass> perInstanceMetaClassMap;
private static final ReferenceBundle softBundle = ReferenceBundle.getSoftBundle();
private static final ReferenceBundle weakBundle = ReferenceBundle.getWeakBundle();
private static final ManagedLinkedList<ClassInfo> modifiedExpandos = new ManagedLinkedList<ClassInfo>(weakBundle);
private static final GroovyClassValue<ClassInfo> globalClassValue = GroovyClassValueFactory.createGroovyClassValue(new ComputeValue<ClassInfo>(){
@Override
public ClassInfo computeValue(Class<?> type) {
ClassInfo ret = new ClassInfo(type);
globalClassSet.add(ret);
return ret;
}
});
private static final GlobalClassSet globalClassSet = new GlobalClassSet();
ClassInfo(Class klazz) {
this.klazz = klazz;
if (ClassInfo.DebugRef.debug)
new DebugRef(klazz);
new ClassInfoCleanup(this);
cachedClassRef = new LazyCachedClassRef(softBundle, this);
artifactClassLoader = new LazyClassLoaderRef(softBundle, this);
}
public int getVersion() {
return version.get();
}
public void incVersion() {
version.incrementAndGet();
VMPluginFactory.getPlugin().invalidateCallSites();
}
public ExpandoMetaClass getModifiedExpando() {
// safe value here to avoid multiple reads with possibly
// differing values due to concurrency
MetaClass strongRef = strongMetaClass;
return strongRef == null ? null : strongRef instanceof ExpandoMetaClass ? (ExpandoMetaClass)strongRef : null;
}
public static void clearModifiedExpandos() {
synchronized(modifiedExpandos){
for (Iterator<ClassInfo> it = modifiedExpandos.iterator(); it.hasNext(); ) {
ClassInfo info = it.next();
it.remove();
info.setStrongMetaClass(null);
}
}
}
public CachedClass getCachedClass() {
return cachedClassRef.get();
}
public ClassLoaderForClassArtifacts getArtifactClassLoader() {
return artifactClassLoader.get();
}
public static ClassInfo getClassInfo (Class cls) {
LocalMap map = getLocalClassInfoMap();
if (map!=null) return map.get(cls);
return globalClassValue.get(cls);
}
private static LocalMap getLocalClassInfoMap() {
ThreadLocalMapHandler handler = localMapRef.get();
SoftReference<LocalMap> ref=null;
if (handler!=null) ref = handler.get();
LocalMap map=null;
if (ref!=null) map = ref.get();
return map;
}
public static Collection<ClassInfo> getAllClassInfo () {
Collection<ClassInfo> localClassInfos = getAllLocalClassInfo();
return localClassInfos != null ? localClassInfos : getAllGlobalClassInfo();
}
public static void onAllClassInfo(ClassInfoAction action) {
Collection<ClassInfo> localClassInfos = getAllLocalClassInfo();
if (localClassInfos!=null) {
for (ClassInfo localClassInfo : localClassInfos) {
action.onClassInfo(localClassInfo);
}
}
for (ClassInfo classInfo : getAllGlobalClassInfo()) {
action.onClassInfo(classInfo);
}
}
private static Collection<ClassInfo> getAllGlobalClassInfo() {
return globalClassSet.values();
}
private static Collection<ClassInfo> getAllLocalClassInfo() {
LocalMap map = getLocalClassInfoMap();
if (map!=null) return map.values();
return globalClassSet.values();
}
public MetaClass getStrongMetaClass() {
return strongMetaClass;
}
public void setStrongMetaClass(MetaClass answer) {
version.incrementAndGet();
// safe value here to avoid multiple reads with possibly
// differing values due to concurrency
MetaClass strongRef = strongMetaClass;
if (strongRef instanceof ExpandoMetaClass) {
((ExpandoMetaClass)strongRef).inRegistry = false;
synchronized(modifiedExpandos){
for (Iterator<ClassInfo> it = modifiedExpandos.iterator(); it.hasNext(); ) {
ClassInfo info = it.next();
if(info == this){
it.remove();
}
}
}
}
strongMetaClass = answer;
if (answer instanceof ExpandoMetaClass) {
((ExpandoMetaClass)answer).inRegistry = true;
synchronized(modifiedExpandos){
for (Iterator<ClassInfo> it = modifiedExpandos.iterator(); it.hasNext(); ) {
ClassInfo info = it.next();
if(info == this){
it.remove();
}
}
modifiedExpandos.add(this);
}
}
replaceWeakMetaClassRef(null);
}
public MetaClass getWeakMetaClass() {
// safe value here to avoid multiple reads with possibly
// differing values due to concurrency
ManagedReference<MetaClass> weakRef = weakMetaClass;
return weakRef == null ? null : weakRef.get();
}
public void setWeakMetaClass(MetaClass answer) {
version.incrementAndGet();
strongMetaClass = null;
ManagedReference<MetaClass> newRef = null;
if (answer != null) {
newRef = new ManagedReference<MetaClass> (softBundle,answer);
}
replaceWeakMetaClassRef(newRef);
}
private void replaceWeakMetaClassRef(ManagedReference<MetaClass> newRef) {
// safe value here to avoid multiple reads with possibly
// differing values due to concurrency
ManagedReference<MetaClass> weakRef = weakMetaClass;
if (weakRef != null) {
weakRef.clear();
}
weakMetaClass = newRef;
}
public MetaClass getMetaClassForClass() {
// safe value here to avoid multiple reads with possibly
// differing values due to concurrency
MetaClass strongMc = strongMetaClass;
if (strongMc!=null) return strongMc;
MetaClass weakMc = getWeakMetaClass();
if (isValidWeakMetaClass(weakMc)) {
return weakMc;
}
return null;
}
private MetaClass getMetaClassUnderLock() {
MetaClass answer = getStrongMetaClass();
if (answer!=null) return answer;
answer = getWeakMetaClass();
final MetaClassRegistry metaClassRegistry = GroovySystem.getMetaClassRegistry();
MetaClassRegistry.MetaClassCreationHandle mccHandle = metaClassRegistry.getMetaClassCreationHandler();
if (isValidWeakMetaClass(answer, mccHandle)) {
return answer;
}
answer = mccHandle.create(klazz, metaClassRegistry);
answer.initialize();
if (GroovySystem.isKeepJavaMetaClasses()) {
setStrongMetaClass(answer);
} else {
setWeakMetaClass(answer);
}
return answer;
}
private boolean isValidWeakMetaClass(MetaClass metaClass) {
return isValidWeakMetaClass(metaClass, GroovySystem.getMetaClassRegistry().getMetaClassCreationHandler());
}
/**
* if EMC.enableGlobally() is OFF, return whatever the cached answer is.
* but if EMC.enableGlobally() is ON and the cached answer is not an EMC, come up with a fresh answer
*/
private boolean isValidWeakMetaClass(MetaClass metaClass, MetaClassRegistry.MetaClassCreationHandle mccHandle) {
if(metaClass==null) return false;
boolean enableGloballyOn = (mccHandle instanceof ExpandoMetaClassCreationHandle);
boolean cachedAnswerIsEMC = (metaClass instanceof ExpandoMetaClass);
return (!enableGloballyOn || cachedAnswerIsEMC);
}
public final MetaClass getMetaClass() {
MetaClass answer = getMetaClassForClass();
if (answer != null) return answer;
lock();
try {
return getMetaClassUnderLock();
} finally {
unlock();
}
}
public MetaClass getMetaClass(Object obj) {
final MetaClass instanceMetaClass = getPerInstanceMetaClass(obj);
if (instanceMetaClass != null)
return instanceMetaClass;
return getMetaClass();
}
public static int size () {
return globalClassSet.size();
}
public static int fullSize () {
return globalClassSet.fullSize();
}
private static CachedClass createCachedClass(Class klazz, ClassInfo classInfo) {
if (klazz == Object.class)
return new ObjectCachedClass(classInfo);
if (klazz == String.class)
return new StringCachedClass(classInfo);
CachedClass cachedClass;
if (Number.class.isAssignableFrom(klazz) || klazz.isPrimitive()) {
if (klazz == Number.class) {
cachedClass = new NumberCachedClass(klazz, classInfo);
} else if (klazz == Integer.class || klazz == Integer.TYPE) {
cachedClass = new IntegerCachedClass(klazz, classInfo, klazz==Integer.class);
} else if (klazz == Double.class || klazz == Double.TYPE) {
cachedClass = new DoubleCachedClass(klazz, classInfo, klazz==Double.class);
} else if (klazz == BigDecimal.class) {
cachedClass = new BigDecimalCachedClass(klazz, classInfo);
} else if (klazz == Long.class || klazz == Long.TYPE) {
cachedClass = new LongCachedClass(klazz, classInfo, klazz==Long.class);
} else if (klazz == Float.class || klazz == Float.TYPE) {
cachedClass = new FloatCachedClass(klazz, classInfo, klazz==Float.class);
} else if (klazz == Short.class || klazz == Short.TYPE) {
cachedClass = new ShortCachedClass(klazz, classInfo, klazz==Short.class);
} else if (klazz == Boolean.TYPE) {
cachedClass = new BooleanCachedClass(klazz, classInfo, false);
} else if (klazz == Character.TYPE) {
cachedClass = new CharacterCachedClass(klazz, classInfo, false);
} else if (klazz == BigInteger.class) {
cachedClass = new BigIntegerCachedClass(klazz, classInfo);
} else if (klazz == Byte.class || klazz == Byte.TYPE) {
cachedClass = new ByteCachedClass(klazz, classInfo, klazz==Byte.class);
} else {
cachedClass = new CachedClass(klazz, classInfo);
}
} else {
if (klazz.getName().charAt(0) == '[')
cachedClass = new ArrayCachedClass(klazz, classInfo);
else if (klazz == Boolean.class) {
cachedClass = new BooleanCachedClass(klazz, classInfo, true);
} else if (klazz == Character.class) {
cachedClass = new CharacterCachedClass(klazz, classInfo, true);
} else if (Closure.class.isAssignableFrom(klazz)) {
cachedClass = new CachedClosureClass (klazz, classInfo);
} else if (isSAM(klazz)) {
cachedClass = new CachedSAMClass(klazz, classInfo);
} else {
cachedClass = new CachedClass(klazz, classInfo);
}
}
return cachedClass;
}
private static boolean isSAM(Class<?> c) {
return CachedSAMClass.getSAMMethod(c) !=null;
}
public void lock () {
lock.lock();
}
public void unlock () {
lock.unlock();
}
public MetaClass getPerInstanceMetaClass(Object obj) {
if (perInstanceMetaClassMap == null)
return null;
return perInstanceMetaClassMap.get(obj);
}
public void setPerInstanceMetaClass(Object obj, MetaClass metaClass) {
version.incrementAndGet();
if (metaClass != null) {
if (perInstanceMetaClassMap == null)
perInstanceMetaClassMap = new ManagedConcurrentMap<Object, MetaClass>(ReferenceBundle.getWeakBundle());
perInstanceMetaClassMap.put(obj, metaClass);
}
else {
if (perInstanceMetaClassMap != null) {
perInstanceMetaClassMap.remove(obj);
}
}
}
public boolean hasPerInstanceMetaClasses () {
return perInstanceMetaClassMap != null;
}
private static final class LocalMap extends HashMap<Class,ClassInfo> {
// We use a PhantomReference or a WeakReference for the Thread
// because the ThreadLocal manages a map with the thread as key.
// If we make a strong reference to the thread here, then it is
// possible, that the map cannot be cleaned. If the number of
// threads is not limited, then this map may consume too much memory
// This reference here is unmanaged (queue==null) because if the map
// key gets collected, the reference will too.
private final PhantomReference<Thread> myThread = new PhantomReference(Thread.currentThread(),null);
private LocalMap() {
}
public ClassInfo get(Class key) {
ClassInfo info = super.get(key);
if (info != null)
return info;
return globalClassValue.get(key);
}
}
private static class ThreadLocalMapHandler extends ThreadLocal<SoftReference<LocalMap>> {
SoftReference<LocalMap> recentThreadMapRef;
protected SoftReference<LocalMap> initialValue() {
return new SoftReference(new LocalMap(),null);
}
public SoftReference<LocalMap> get() {
SoftReference<LocalMap> mapRef = recentThreadMapRef;
LocalMap recent = null;
if (mapRef!=null) recent = mapRef.get();
// we don't need to handle myThread.get()==null, because in that
// case the thread has been collected, meaning the entry for the
// thread is invalid anyway, so it is valid if recent has a
// different value.
if (recent != null && recent.myThread.get() == Thread.currentThread()) {
return mapRef;
} else {
SoftReference<LocalMap> ref = super.get();
recentThreadMapRef = ref;
return ref;
}
}
}
private static final WeakReference<ThreadLocalMapHandler> localMapRef;
static {
ThreadLocalMapHandler localMap = new ThreadLocalMapHandler();
localMapRef = new WeakReference<ThreadLocalMapHandler>(localMap,null);
}
private static class LazyCachedClassRef extends LazyReference<CachedClass> {
private final ClassInfo info;
LazyCachedClassRef(ReferenceBundle bundle, ClassInfo info) {
super(bundle);
this.info = info;
}
public CachedClass initValue() {
return createCachedClass(info.klazz, info);
}
}
private static class LazyClassLoaderRef extends LazyReference<ClassLoaderForClassArtifacts> {
private final ClassInfo info;
LazyClassLoaderRef(ReferenceBundle bundle, ClassInfo info) {
super(bundle);
this.info = info;
}
public ClassLoaderForClassArtifacts initValue() {
return new ClassLoaderForClassArtifacts(info.klazz);
}
}
private static class ClassInfoCleanup extends ManagedReference<ClassInfo> {
public ClassInfoCleanup(ClassInfo classInfo) {
super(weakBundle, classInfo);
}
public void finalizeRef() {
ClassInfo classInfo = get();
classInfo.setStrongMetaClass(null);
classInfo.cachedClassRef.clear();
classInfo.artifactClassLoader.clear();
}
}
private static class DebugRef extends ManagedReference<Class> {
public static final boolean debug = false;
private static final AtomicInteger count = new AtomicInteger();
final String name;
public DebugRef(Class klazz) {
super(softBundle, klazz);
name = klazz == null ? "<null>" : klazz.getName();
count.incrementAndGet();
}
public void finalizeRef() {
//System.out.println(name + " unloaded " + count.decrementAndGet() + " classes kept");
super.finalizeReference();
}
}
private static class GlobalClassSet {
private final ManagedLinkedList<ClassInfo> items = new ManagedLinkedList<ClassInfo>(weakBundle);
public int size(){
return values().size();
}
public int fullSize(){
return values().size();
}
public Collection<ClassInfo> values(){
synchronized(items){
return Arrays.asList(items.toArray(new ClassInfo[0]));
}
}
public void add(ClassInfo value){
synchronized(items){
items.add(value);
}
}
}
public static interface ClassInfoAction {
void onClassInfo(ClassInfo classInfo);
}
}